home *** CD-ROM | disk | FTP | other *** search
/ QRZ! Ham Radio 1 / QRZ Ham Radio Callsign Database - December 1993.iso / ucsd / packet / misc / ad15dis.exe / SYSOP.DOC < prev    next >
Encoding:
Text File  |  1991-01-21  |  24.5 KB  |  454 lines
  1. SYSOP.DOC      ARES/Data V. 1.5 Sysop Information and Reference
  2.  
  3. The ARES/Data software was written in Turbo Pascal 5.5 on an IBM PC by
  4. WN6I, W. E. Moerner, and N6KL, Dave Palmer.  It may be run in either
  5. of two modes: (a) stand-alone with no TNC support and no remote access, or
  6. (b) by changing the configuration file, the program will control up to four
  7. ports (TNC's), each of which can have up to 10 simultaneous connections.
  8. If TNC support is chosen, the program requires that each port be either
  9. (a) a TNC with WA8DED firmware or (b) a Digital Radio Systems PC*PA
  10. Packet adapter card (because WA8DED's host mode is used for
  11. communication between the computer and the TNCs), OR a KISS-mode TNC
  12. with the G8BPQ 4.01 switch code running as a terminate and stay resident
  13. program in the computer.  NOTE:  NO REQUIREMENT IS PLACED ON THE OTHER
  14. TNC's THAT ARE REMOTELY CONNECTED TO THE ARES/Data DATABASE MACHINE,
  15. except that they use AX.25 link-layer protocol!  The ARES/Data program
  16. utilizes the Turbo Database Toolbox V.  4.0 for management and searching
  17. of its B-plus structured indexing tree.
  18.  
  19.  
  20. 1.  These instructions are aimed at those who will be actually running
  21. the ARES/Data program, or for those interested in some of the
  22. operational detail.  You need not read this file in order to effectively
  23. use the program as a remotely connected packet operator.  These
  24. instructions are abbreviated, so be sure to read the ARES/Data
  25. documentation file USERMAN.DOC first for general background information
  26. and the commands available to the remote packet operator.  You may also
  27. want to read about the ancestor of ARES/Data, the FINDER system, in the
  28. 6th ARRL Computer Networking Conference Proceedings.  An article about
  29. ARES/Data V. 0.1 appeared in the 7th ARRL Computer Networking
  30. Conference Proceedings, and the revised text of this article is included
  31. with the documentation.  In addition, the text of an article on ARES/Data
  32. Version 1.0 from the 8th ARRL Computer Networking Conference Proceedings
  33. is included on the distribution diskette.  For applications of ARES/Data,
  34. see QST, December 1990, p. 75.
  35.  
  36. 2.  You need an IBM PC or compatible to run the program with at least
  37. two drives, one of which should be a hard disk or hard card, if
  38. possible.  ARES/Data has been tested on a PC, XT, AT, PS/2 and a PC
  39. Convertible using DOS 3.21 and higher.  (The program also appears to run
  40. fairly well on the PCjr.) In addition, if you want to allow remote
  41. packet radio access to the database, you need at least one serial port
  42. OR at least one Digital Radio Systems PC*PA packet adapter.
  43.  
  44. 3.  Assuming you want to allow remote access to the database with
  45. packet, you have three alternatives for the TNC configuration at the
  46. host database station where ARES/Data is running:
  47.  
  48. IF YOUR TNC IS:
  49.  
  50. ****A****:  A TNC that operates in WA8DED host mode, then you must
  51. connect the TNC to the computer with a standard serial port, and you
  52. must load the terminate-and-stay-resident (TSR) program MBBIOS.COM
  53. before running ARES/Data.
  54.  
  55. WA8DED host mode is implemented for the TNC1, true TNC2 clones, and the
  56. PK-87/88 by using firmware (an EPROM) written by Ron Raikes, WA8DED.
  57. (Note - this is not referring to NET/ROM firmware, but rather to the
  58. user-mode TNC firmware written by WA8DED.) ARES/Data has been tested on
  59. several TNC-1's with WA8DED firmware Version 1.3 modified for 8
  60. simultaneous connects, on several TNC-2's with WA8DED firmware Version
  61. 2.5, on several PK-87's with WA8DED firmware (32K).  If your usage is
  62. totally non-commercial, you can get the WA8DED public domain firmware
  63. yourself from many sources; see your local packet hacker, or it is
  64. available from the Tucson Amateur Packet Radio group--TAPR.  For
  65. details, call TAPR at (602) 323-1710.
  66.  
  67. Take a few minutes to learn the "DEDware" user mode command syntax - it
  68. is different from the TAPR syntax, but easy to learn.  The WA8DED user
  69. mode documentation is included on the distribution diskette in the files
  70. TNC1DED.DOC, TNC2DED.DOC, and PK87DED.DOC.
  71.  
  72. Some hints:  Remember that you are always in converse mode, and pressing
  73. "<esc>" puts you into command mode for one line at a time.
  74. "<esc>S 0<cr>" selects channel 0, the unproto channel,
  75. "<esc>I callsign<cr>" sets callsign (do this only from channel 0),
  76. "<esc>S 1<cr>" selects channel 1 to start a connection,
  77. "<esc>C callsign<cr>" causes a connect (requires channel > 0)
  78. "<esc>D<cr>" a disconnect, etc.
  79.  
  80.  
  81. ****B****:  A Digital Radio Systems Inc.  (DRSI) PC*PA packet adapter,
  82. then you will load the TSR program TNCTSR-S.EXE before running
  83. ARES/Data.
  84.  
  85. DRSI boards automatically speak the WA8DED host mode.  READ DRSI.DOC FOR
  86. DETAILS.
  87.  
  88.  
  89. ****C****:Any other kind of TNC (such as PK-232, KAM, etc.), then you
  90. must use a standard serial port to connect the computer to your TNC, and
  91. you must put your TNC into KISS (keep it simple, stupid) mode.  You then
  92. must load the G8BPQ switch TSR code version 4.01 to make your KISS TNC a
  93. true packet switch.  You must also load the TSR DEDHOSFE.COM to force
  94. the switch to talk to ARES/Data as if it were a WA8DED TNC, before
  95. running ARES/Data.  READ G8BPQ.COM FOR MORE DETAILS.
  96.  
  97.  
  98.  
  99. 4.  The ARES/Data program, a relative of the FINDER program, is in the
  100. public domain and is available for no-cost distribution from WN6I or
  101. N6KL by sending a blank, formatted 5 1/4" (360 kB) or 3 1/2" (720 kB)
  102. floppy with SASE for return to you.  The program may be distributed
  103. freely, so long as the distribution is for no cost.  Therefore, the cost
  104. to you is the cost of the diskette and return postage.  We have included
  105. a configuration file facility so that you can tailor many parameters to
  106. your system.  If you want small changes in the code, we will try to
  107. accommodate you, but we cannot make any guarantees.
  108.  
  109. 5. ARES/Data database file usage:
  110.  
  111. Main database files:
  112.    ARESDATA.DAT                 the database itself - all records
  113.    FIELD1.NDX                   index file for field1
  114.    FIELD2.NDX                   index file for field2
  115.    FIELD3.NDX                   index file for field3
  116.    FIELD4.NDX                   index file for field4
  117.  
  118. Backup files:
  119.    ARESDATA.JRN                 journal file - a normal ASCII file containing
  120.                                 a listing of all valid current information
  121.                                 packets.  May be edited, printed, or used as
  122.                                 input to the ARES/Data program to recover a
  123.                                 damaged or erased database.
  124.  
  125.    ARESDATA.BAK                 backup of the database
  126.    FIELD1.BAK                   index file for field 1 backup
  127.    FIELD2.BAK                   index file for field 2 backup
  128.    FIELD3.BAK                   index file for field 3 backup
  129.    FIELD4.BAK                   index file for field 4 backup
  130.  
  131.  
  132. 6.  Before starting ARES/Data, be sure your hardware is set up correctly.
  133. Test the TNC and WA8DED firmware by using your own terminal emulator first.
  134. If you have a DRSI board, test it with the TNCX-S.EXE program that comes
  135. with it.  If you are using a KISS TNC and the G8BPQ switch code, test
  136. the switch independently first.
  137.  
  138. 7.  Edit the configuration file ARESDATA.CFG to reflect your system
  139. configuration.  As distributed, ARESDATA.CFG is set up for no packet
  140. support, so you must edit this file to tell the system what kind of TNC
  141. you are using.  READ THE FILE CONFIG.DOC for details on ARESDATA.CFG!
  142. NOW.
  143.  
  144. 8.  Edit the startup file STARTUP.XXX you specified in ARESDATA.CFG to
  145. set your callsign.  If you are using BPQ, the callsign is set separately
  146. by the switch configuration, and there is no need for a STARTUP.XXX
  147. file.
  148.  
  149. 9.  IMPORTANT:  YOU MUST MAKE SURE A LINE LIKE THE FOLLOWING APPEARS
  150. IN YOUR SYSTEM'S CONFIG.SYS FILE ON THE BOOT DISK(ETTE):
  151.  
  152. FILES=20
  153.  
  154. ARES/Data uses many disk files while running, so if an entry for FILES=
  155. doesn't exist, or is set lower than 20, the program may not run correctly.
  156. (Setting FILES= to a value higher than 20 typically has no effect).
  157. For better performance, you may also want to set BUFFERS=20 or some
  158. higher value.  BUFFERS=20 is probably a good choice; use of a higher
  159. value will consume additional DOS memory without much greater
  160. performance gain.  You may want to set a lower value for BUFFERS= if
  161. you are using some form of disk caching program.
  162.  
  163. 10. To start ARES/Data:  If you have selected automatic startup, be
  164. sure the drives have disks in them.  If you have defined some TNC
  165. interfaces, be sure that the TNC(s) is(are) on.  If you are using the
  166. BPQ switch code, start it first using STARTBPQ.BAT.  Then start the
  167. execution of ARES/Data by typing "ARESDATA<CR>".  This runs the batch
  168. file ARESDATA.BAT.  Be sure to edit ARESDATA.BAT to load MBBIOS if you
  169. are using any serial ports for connection to TNCs.  Also, be sure to
  170. edit this file to load TNCTSR-S if you have any DRSI boards.
  171.  
  172. 11.  The startup sequence is fairly self-explanatory.  If you have not
  173. selected TNC support, all TNC-related functions are disabled.  The sysop
  174. console is the only input/output port in the system.
  175.  
  176. If you have defined some TNC interfaces and have selected automatic
  177. startup, no prompting will be done and after processing the .cfg file
  178. and opening the database files, the program will automatically enter
  179. host mode and begin polling the available channels for data.  Note that
  180. sometimes the TNC and the computer will not synchronize immediately.
  181. Don't be alarmed at the messages scrolling across your screen regarding
  182. "TNC Recover" at initial startup time.  If this occurs for more than 60
  183. sec., cycle the power on the TNC.
  184.  
  185. If you have selected prompted startup, you will be prompted to put a
  186. diskette in the drive you have selected for the backup/journaling
  187. function.  Then you are prompted to turn on the TNC.  When TNC-computer
  188. synchronization is established, the run-time status screen is displayed
  189. and several TNC parameters are set.  Don't be alarmed at the messages
  190. scrolling across your screen regarding "TNC Recover" at initial startup
  191. time.  The program does not know the state of the TNC, and if the TNC
  192. does not respond to host mode commands, the program will eventually
  193. issue the appropriate "JHOST1" command.  (TCP/IP users:  If you have the
  194. TNC2 WA8DED+KISS Mode Combination EPROM, ARES/Data works fine with that,
  195. too.  You need not enter the initial "H" command following power up).
  196.  
  197. In all cases, if previous database files are found, they are opened.  If
  198. none are found, new database files are created.  NOTE: after each
  199. disaster, you should rename the database files to start with a fresh
  200. (empty) database.  You can do this easily with the batch file ZAPDB.BAT
  201. that is provided with ARES/Data.  ZAPDB.BAT takes one argument: a name
  202. identifying the event, i.e., you type "zapdb medex1<cr>".  The batch
  203. file copies the database and index files to new files with the filenames
  204. "medex1.dat", "medex1.nd1", etc. and then erases the standard database
  205. and index files.  Presto - the next time you start ARES/Data, new
  206. database and index files will be created.
  207.  
  208. 11.  The sysop keyboard can enter current information input and search
  209. requests like any connected channel, but don't try to type too fast if
  210. TNC polling is in progress.  If you have problems with this, press F5 to
  211. stop polling for ten seconds so that you can enter your data.  See the
  212. file USERMAN.DOC for a summary of the standard packet operator commands.
  213.  
  214. 12.  The sysop status screen (assuming at least one TNC interface or
  215. port is defined):  The top half of the screen starts out showing the
  216. channel activity for the first interface defined (interface A).  The
  217. lower half of the screen has at the very bottom an input line for sysop
  218. commands and above this an information window where recent commands and
  219. database functions are echoed.  The interface that is showing at the top
  220. half of the screen is called the "default interface".  You can change
  221. the displayed interface to any other interface that you have defined by
  222. pressing "<alt><F1>" for interface A, "<alt><F2>" for interface B,
  223. "<alt><F3>" for interface C, and "<alt><F4>" for interface 4.  If you
  224. press one of these key sequences for an interface that is not defined,
  225. the status screen disappears.  This is useful if you really want a
  226. larger sysop screen, for example.  To get a status screen back for a
  227. particular interface, just press the <alt> key sequence for that
  228. interface.
  229.  
  230. 13.  The sysop can also send commands directly to the default interface
  231. by typing <ESC> and the one-letter command as is usual for the WA8DED
  232. user-mode firmware.  Some commands (such as "d" for disconnect) can
  233. reference a specific channel:  to set the channel for these commands,
  234. first type "<ESC>Sn<CR>", where n is the channel number.  The currently
  235. selected channel is marked with a triangular arrow on the sysop screen.
  236. For example, to force a disconnect on channel 3, type "<ESC>S3 <CR>
  237. <ESC>d <CR>".
  238.  
  239. 14.  The sysop can send messages to connected channels for the default
  240. interface in several ways:  (a) by typing "<ESC>n message<CR>" where n is
  241. the channel number, or (b) by using the "tell" command described in
  242. USERMAN.DOC.  Note that the sysop can send a QST to all connected
  243. channels on all valid interfaces by typing "tell all msg"<CR> or "tell *
  244. msg"<CR>, where "msg" is the text to be sent.
  245.  
  246. 15.  Special SYSOP-only commands:
  247.  
  248.         deleteon                enables use of delete command by connected
  249.                                 stations for default interface
  250.  
  251.         deleteoff               disables use of delete command by remote
  252.                                 stations for the default interface.  Note
  253.                                 that the delete command is always enabled
  254.                                 for the sysop.
  255.  
  256.         labels=label1,label2,label3,label4,msglabel
  257.  
  258.                                 sets labels for database fields 1-4 and
  259.                                 msg field.  Note that this command can
  260.                                 be in ARESDATA.CFG to give a standard
  261.                                 startup default label set.
  262.  
  263.         widths=wid1,wid2,wid3,wid4
  264.  
  265.                                 sets default printing widths for fields
  266.                                 1-4.  Note that this command can also
  267.                                 be in ARESDATA.CFG.
  268.  
  269.         export filename         sends complete database to filename
  270.                                 specified with date and time attached to
  271.                                 the beginning of each record.  I.E.,
  272.                                 Date,Time,Field1,Field2,Field3,Field4,Msg
  273.  
  274.         import filename         reads filename specified in same format
  275.                                 used by the export filename command
  276.                                 and adds the data found to the current
  277.                                 database, using the dates and times specified.
  278.                                 Note that the input format for each record is:
  279.                                 Date,Time,Field1,Field2,Field3,Field4,Msg
  280.                                 If you don't have a meaningful date and time
  281.                                 to attach to each record, use "importraw".
  282.  
  283.         rawimport filename      reads filename specified in standard ARES/Data
  284.                                 input format and adds the data found to the
  285.                                 current database.  Input format for each record
  286.                                 is:
  287.                                 Field1,Field2,Field3,Field4,Msg
  288.                                 This command is useful is you have a large
  289.                                 database available in advance that you want
  290.                                 to read in and make available to remote
  291.                                 stations.  The date and time added to each
  292.                                 record is the current date and time.
  293.  
  294.         logallon                enable/disable logging of every packet
  295.         logalloff               entered to the sysop screen.  If the printer
  296.                                 is on, this causes logging of all
  297.                                 transactions.
  298.  
  299.  
  300. 16.  Special PF keys:
  301.  
  302.         F1              Immediate database backup: closes all files, copies
  303.                         current database files to the .BAK versions, and
  304.                         flushes the last few valid current information
  305.                         packets into the .JRN file.  Note 1: if communication
  306.                         is lost on the computer to TNC wire link, a backup
  307.                         is performed automatically, and the program
  308.                         attempts to resynchronize with the TNC.
  309.                         Note 2: Backup can also occur automatically after
  310.                         a desired number of new database entries have been
  311.                         entered.  This number is set by the "backup" parameter
  312.                         in ARESDATA.CFG.
  313.  
  314.         F2              Mode selector for the currently selected channel.
  315.                         Pressing the key cycles through three modes:
  316.                             Mode 0 - all packet operator functions enabled
  317.                             Mode 1 - "tell" and "users" only enabled
  318.                             Mode 2 - chat mode only, which looks like normal
  319.                                        terminal operation.
  320.  
  321.                         There is a fourth mode, mode 3 - degraded mode, which
  322.                         occurs automatically when disk full or near-disk-full
  323.                         conditions occur.  For mode 3, the database becomes
  324.                         read-only, but the user/tell functions are still
  325.                         operable.  The current mode for each channel is
  326.                         indicated on the sysop screen.  Mode 0 has no character
  327.                         next to the channel number, mode 1 has a small square,
  328.                         mode 2 has an "x", and mode 3 has a slash ("/") next to
  329.                         the channel number.  Upon startup, all channels are set
  330.                         to mode 0.  Mode 2 is useful to prevent a "jammer" from
  331.                         tampering with the database, or for normal terminal-mode
  332.                         connection to another station or BBS.  Mode 1 is useful
  333.                         for a round-table discussion only, without access to the
  334.                         database.
  335.  
  336.         <CTRL>F3        Shut down the program gracefully.  If the program is
  337.                         subsequently restarted from DOS, it will pick up where
  338.                         it left off.
  339.  
  340.         F5              Suspend polling of channels.  Use this if you
  341.                         experience missed characters during keyboard
  342.                         input.  Polling automatically restarts in 10 seconds.
  343.  
  344.         F6              Redraw the sysop screen.
  345.  
  346.         F7              Send a full ASCII report of the database to file
  347.                         ARDAhhmm.RPT on drive A:, where "hhmm" is the
  348.                         current time.   This includes summaries
  349.                         on all four fields plus a listing of every
  350.                         record.
  351.  
  352.         F8              Same as the F7 command, but sends the report to
  353.                         drive B:.
  354.  
  355.         F10             Toggle printer.  All lines printed in the main part of
  356.                         the sysop screen will be echoed on the printer.  NOTE:
  357.                         this can slow down the polling loop dramatically.
  358.                         If your printer runs out of paper or has an I/O
  359.                         error, the program will retry for about 30 seconds,
  360.                         then give up on the printer.  Polling will continue,
  361.                         but no further output will be sent to the printer
  362.                         until you hit F10 again.  NOTE FURTHER: turning
  363.                         the printer on is a nice way to catch responses
  364.                         that scroll off the sysop screen.  When connected users
  365.                         use the "tell sysop" command, these messages go to
  366.                         the screen and, optionally, to the printer, if the
  367.                         printer is enabled with this F10 command.
  368.  
  369. 17.  To terminate execution, use the sequence <CTRL><F3>.  <CTRL><BREAK>
  370. may be used to exit only during a tncrecover.  At other times,
  371. <CTRL><BREAK> has no effect.  <CTRL><F3> is best, because the program
  372. then properly closes all files.
  373.  
  374. 18.  If you have TNC errors, under certain conditions the program will
  375. execute a TNC reset and/or a TNC recovery procedure.  When this occurs,
  376. the first thing that happens is a backup.  The program should recover by
  377. itself.  Be patient.  As a last resort, you can try turning off the TNC
  378. and then turn it on again.  Note that you will then lose all packets in
  379. the receive and transmit queues, however.  If you are really paranoid
  380. and you are using an IBM PC, you can connect the cassette motor relay to
  381. the reset circuit on your TNC.  The TNC reset procedure will close the
  382. relay if it appears that the TNC fails to respond.  We haven't seemed to
  383. ever need this feature, though!  If you still are having TNC errors, try
  384. lowering the baud rate or increasing the serial port retry count
  385. parameter.
  386.  
  387. New for version 1.4 is recovery from the TNC Busy condition.  With
  388. version 1.4, if the TNC responds "BUSY", ARES/Data will do the
  389. following:  The database will be backed up, a message will print on the
  390. SYSOP screen that the TNC was busy, and the program will loop in this
  391. mode, resending the data that the TNC rejected, until the TNC accepts
  392. the data.  In other words, polling is interrupted to allow the TNC
  393. buffer to empty.  In this way, no data should be lost.  This condition
  394. is usually caused by the program attempting to transmit too much data to
  395. users either because someone issued a GET command to download a large
  396. file, or because of a "list all" command, or other command that
  397. generated a large amount of output.
  398.  
  399. Note that you can always terminate a long GET or a "l all" by asking the
  400. remote user to disconnect from ARES/Data.  The only way the sysop can
  401. interrupt a long GET or a "l all" is to use <ctl>-C to kill the program.
  402.  
  403. 19.  Usually, most search requests will be satisfied by the portion of the
  404. index file that is in memory.  However, if you have a very large database (over
  405. 2000 records), more and more disk accesses will be required for each search.
  406. If you think you would like to use a very large database, remember that it may
  407. be hard to fill it over 1200 baud packet radio!  If you really expect to have
  408. an especially large database, you may want to contact us so that we can
  409. recompile the program with different database and index file parameters.  For
  410. example, we can control the number of pages of the index file that are kept in
  411. memory, etc. and in so doing we can optimize the database performance for these
  412. special cases.  Version 1.2 has been tested with 5000 records and will probably
  413. work fine for 10,000 records.  If you need more than that, we can re-compile
  414. the program for you.
  415.  
  416. 20. In case of difficulty:  If data returned from the database does
  417. not make sense, or records appear to be missing that you thought were
  418. present, it may be that your database has become corrupted.  This can
  419. occur if you do not have FILES=20 in your CONFIG.SYS (see Section 8,
  420. above) or if power to the computer was lost in the middle of an
  421. update, etc.   If you were using a test database, move the database to
  422. new names using the ZAPDB batch file and start over:
  423.  
  424. C:\DATA>zapdb junkdata
  425.  
  426. ZAPDB copies your existing database, journal, and index files to new
  427. names, and erases the existing database files.  Restarting ARES/Data
  428. will result in a clean slate.  If the database contained useful
  429. information, then run ZAPDB as above, but then try to IMPORT the old
  430. journal file.  If only some of the data was of value, you can edit the
  431. journal file with any DOS text editor.  In the example above, the old
  432. journal file is now called "junkdata.jrn", and the SYSOP command to
  433. import it would be:
  434.  
  435. import junkdata.jrn
  436.  
  437.  
  438. 21.  Remember that ARES/Data is designed to be general and flexible.
  439. This means that little error checking is done on input packets.
  440. Garbage in, garbage out!
  441.  
  442. 22. Good luck!
  443.  
  444. 23.  If good luck is insufficient, or if you have comments or
  445. suggestions, please contact either of us at
  446.  
  447. W. E. Moerner, WN6I, 1003 Belder Drive, San Jose, CA 95120-3302  408-997-3195
  448.      (WN6I @ K3MC, MOERNER@IBM.COM (internet))
  449.  
  450. Dave Palmer, N6KL, 248 Omira Drive, San Jose CA  95123-3632 408-227-5236
  451.      (N6KL @ K3MC, N6KL@IBM.COM (internet) or 73357,3157 (Compuserve))
  452.  
  453. END SYSOP.DOC
  454.